package com.nageoffer.shortlink.admin.service;

import com.baomidou.mybatisplus.extension.service.IService;
import com.nageoffer.shortlink.admin.dao.entity.UserDO;
import com.nageoffer.shortlink.admin.dto.req.UserLoginReqDTO;
import com.nageoffer.shortlink.admin.dto.req.UserRegisterReqDTO;
import com.nageoffer.shortlink.admin.dto.req.UserUpdateReqDTO;
import com.nageoffer.shortlink.admin.dto.resp.UserLoginRespDTO;
import com.nageoffer.shortlink.admin.dto.resp.UserRespDTO;

/**
* @author 49523
* @description 针对表【t_user(用户表)】的数据库操作Service
* @createDate 2024-10-14 16:19:34
*/
public interface UserService extends IService<UserDO> {


    /**
     * 根据用户名返回用户实体
     * @param username 用户姓名
     * @return 用户实体
     */
    UserRespDTO getUserByUsername(String username);

    /**
     * 根据用户名查看用户是否存在
     * @param username 用户名
     * @return 用户存在返回 True 不存在 false
     */
    Boolean availableUsername(String username);

    /**
     * 注册新用户
     * @param userRegisterReqDTO 用户注册请求参数
     */
    void register(UserRegisterReqDTO userRegisterReqDTO);

    /**
     * 修改用户
     * @param userUpdateReqDTO 用户更新请求参数
     */
    void update(UserUpdateReqDTO userUpdateReqDTO);

    /**
     * 用户登录
     * @param userLoginReqDTO 用户登录请求参数
     * @return 用户登录返回参数 Token
     */
    UserLoginRespDTO login(UserLoginReqDTO userLoginReqDTO);

    /**
     * 查看用户是否登录
     * @param username 用户姓名
     * @param token 用户token
     * @return ture:登录 false:未登录
     */
    Boolean checkLogin(String username, String token);

    /**
     * 退出登录
     * @param username 用户姓名
     * @param token 用户token
     */
    void logout(String username, String token);

}
